home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / Connections.a < prev    next >
Text File  |  1996-05-01  |  13KB  |  534 lines
  1. ;
  2. ;    File:        Connections.a
  3. ;
  4. ;    Contains:    Communications Toolbox Connection Manager Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__CONNECTIONS__') = 'UNDEFINED' THEN
  19. __CONNECTIONS__ SET 1
  20.  
  21.     IF &TYPE('__WINDOWS__') = 'UNDEFINED' THEN
  22.     include 'Windows.a'
  23.     ENDIF
  24.     IF &TYPE('__DIALOGS__') = 'UNDEFINED' THEN
  25.     include 'Dialogs.a'
  26.     ENDIF
  27.     IF &TYPE('__CTBUTILITIES__') = 'UNDEFINED' THEN
  28.     include 'CTBUtilities.a'
  29.     ENDIF
  30.     IF FOR_SYSTEM7_ONLY THEN
  31.  
  32.                                                             ;    current Connection Manager version    
  33. curCMVersion                    EQU        2                    ;    current Connection Manager Environment Record version     
  34. curConnEnvRecVers                EQU        0                    ; CMErr 
  35. cmGenericError                    EQU        -1
  36. cmNoErr                            EQU        0
  37. cmRejected                        EQU        1
  38. cmFailed                        EQU        2
  39. cmTimeOut                        EQU        3
  40. cmNotOpen                        EQU        4
  41. cmNotClosed                        EQU        5
  42. cmNoRequestPending                EQU        6
  43. cmNotSupported                    EQU        7
  44. cmNoTools                        EQU        8
  45. cmUserCancel                    EQU        9
  46. cmUnknownError                    EQU        11
  47. ; typedef OSErr                         CMErr
  48.  
  49.  
  50. cmData                            EQU        $00000001
  51. cmCntl                            EQU        $00000002
  52. cmAttn                            EQU        $00000004
  53. cmDataNoTimeout                    EQU        $00000010
  54. cmCntlNoTimeout                    EQU        $00000020
  55. cmAttnNoTimeout                    EQU        $00000040
  56. cmDataClean                        EQU        $00000100
  57. cmCntlClean                        EQU        $00000200
  58. cmAttnClean                        EQU        $00000400            ;        Only for CMRecFlags (not CMChannel) in the rest of this enum    
  59. cmNoMenus                        EQU        $00010000
  60. cmQuiet                            EQU        $00020000
  61. cmConfigChanged                    EQU        $00040000
  62. ;  CMRecFlags and CMChannel        
  63. ;         Low word of CMRecFlags is same as CMChannel    
  64. ; typedef long                             CMRecFlags
  65.  
  66. ; typedef short                         CMChannel
  67.  
  68.  
  69. cmStatusOpening                    EQU        $00000001
  70. cmStatusOpen                    EQU        $00000002
  71. cmStatusClosing                    EQU        $00000004
  72. cmStatusDataAvail                EQU        $00000008
  73. cmStatusCntlAvail                EQU        $00000010
  74. cmStatusAttnAvail                EQU        $00000020
  75. cmStatusDRPend                    EQU        $00000040            ; data read pending    
  76. cmStatusDWPend                    EQU        $00000080            ; data write pending    
  77. cmStatusCRPend                    EQU        $00000100            ; cntl read pending    
  78. cmStatusCWPend                    EQU        $00000200            ; cntl write pending    
  79. cmStatusARPend                    EQU        $00000400            ; attn read pending    
  80. cmStatusAWPend                    EQU        $00000800            ; attn write pending    
  81. cmStatusBreakPend                EQU        $00001000
  82. cmStatusListenPend                EQU        $00002000
  83. cmStatusIncomingCallPresent        EQU        $00004000
  84. cmStatusReserved0                EQU        $00008000
  85. ; typedef unsigned long                 CMStatFlags
  86.  
  87.  
  88. cmDataIn                        EQU        0
  89. cmDataOut                        EQU        1
  90. cmCntlIn                        EQU        2
  91. cmCntlOut                        EQU        3
  92. cmAttnIn                        EQU        4
  93. cmAttnOut                        EQU        5
  94. cmRsrvIn                        EQU        6
  95. cmRsrvOut                        EQU        7
  96. ; typedef unsigned short                 CMBufFields
  97.  
  98. CMBuffers                RECORD 0
  99. elements                 ds.l    8
  100. sizeof                     EQU *                    ; size:   $20 (32)
  101.                         ENDR
  102.  
  103.  
  104. CMBufferSizes            RECORD 0
  105. elements                 ds.l    8
  106. sizeof                     EQU *                    ; size:   $20 (32)
  107.                         ENDR
  108.  
  109.  
  110.  
  111. cmSearchSevenBit                EQU        $00000001
  112. ; typedef unsigned short                 CMSearchFlags
  113.  
  114.  
  115. cmFlagsEOM                        EQU        $00000001
  116. ; typedef unsigned short                 CMFlags
  117.  
  118. ConnEnvironRec            RECORD 0
  119. version                     ds.w    1                ; offset: $0 (0)
  120. baudRate                 ds.l    1                ; offset: $2 (2)
  121. dataBits                 ds.w    1                ; offset: $6 (6)
  122. channels                 ds.w    1                ; offset: $8 (8)
  123. swFlowControl             ds.b    1                ; offset: $A (10)
  124. hwFlowControl             ds.b    1                ; offset: $B (11)
  125. flags                     ds.w    1                ; offset: $C (12)
  126. sizeof                     EQU *                    ; size:   $E (14)
  127.                         ENDR
  128. ; typedef struct ConnEnvironRec *        ConnEnvironRecPtr
  129.  
  130.  
  131.  
  132. ; typedef ConnRecord *                    ConnPtr
  133.  
  134. ; typedef ConnPtr *                        ConnHandle
  135.  
  136. ConnRecord                RECORD 0
  137. procID                     ds.w    1                ; offset: $0 (0)
  138. flags                     ds.l    1                ; offset: $2 (2)
  139. errCode                     ds.w    1                ; offset: $6 (6)
  140. refCon                     ds.l    1                ; offset: $8 (8)
  141. userData                 ds.l    1                ; offset: $C (12)
  142. defProc                     ds.l    1                ; offset: $10 (16)
  143. config                     ds.l    1                ; offset: $14 (20)
  144. oldConfig                 ds.l    1                ; offset: $18 (24)
  145. asyncEOM                 ds.l    1                ; offset: $1C (28)
  146. reserved1                 ds.l    1                ; offset: $20 (32)
  147. reserved2                 ds.l    1                ; offset: $24 (36)
  148. cmPrivate                 ds.l    1                ; offset: $28 (40)
  149. bufferArray                 ds        CMBuffers        ; offset: $2C (44)
  150. bufSizes                 ds        CMBufferSizes    ; offset: $4C (76)
  151. mluField                 ds.l    1                ; offset: $6C (108)
  152. asyncCount                 ds        CMBufferSizes    ; offset: $70 (112)
  153. sizeof                     EQU *                    ; size:   $90 (144)
  154.                         ENDR
  155.  
  156.                                                             ; CMIOPB constants and structure 
  157. cmIOPBQType                        EQU        10
  158. cmIOPBversion                    EQU        0
  159. CMIOPB                    RECORD 0
  160. qLink                     ds.l    1                ; offset: $0 (0)
  161. qType                     ds.w    1                ; offset: $4 (4)        ;  cmIOPBQType 
  162. hConn                     ds.l    1                ; offset: $6 (6)
  163. theBuffer                 ds.l    1                ; offset: $A (10)
  164. count                     ds.l    1                ; offset: $E (14)
  165. flags                     ds.w    1                ; offset: $12 (18)
  166. userCompletion             ds.l    1                ; offset: $14 (20)
  167. timeout                     ds.l    1                ; offset: $18 (24)
  168. errCode                     ds.w    1                ; offset: $1C (28)
  169. channel                     ds.w    1                ; offset: $1E (30)
  170. asyncEOM                 ds.l    1                ; offset: $20 (32)
  171. reserved1                 ds.l    1                ; offset: $24 (36)
  172. reserved2                 ds.w    1                ; offset: $28 (40)
  173. version                     ds.w    1                ; offset: $2A (42)        ;  cmIOPBversion 
  174. refCon                     ds.l    1                ; offset: $2C (44)        ;  for application 
  175. toolData1                 ds.l    1                ; offset: $30 (48)        ;  for tool 
  176. toolData2                 ds.l    1                ; offset: $34 (52)        ;  for tool 
  177. sizeof                     EQU *                    ; size:   $38 (56)
  178.                         ENDR
  179. ; typedef struct CMIOPB *                CMIOPBPtr
  180.  
  181. ;
  182. ; pascal CMErr InitCM(void )
  183. ;
  184.     IF GENERATINGCFM THEN
  185.         IMPORT_CFM_FUNCTION InitCM
  186.     ENDIF
  187.  
  188. ;
  189. ; pascal Handle CMGetVersion(ConnHandle hConn)
  190. ;
  191.     IF GENERATINGCFM THEN
  192.         IMPORT_CFM_FUNCTION CMGetVersion
  193.     ENDIF
  194.  
  195. ;
  196. ; pascal short CMGetCMVersion(void )
  197. ;
  198.     IF GENERATINGCFM THEN
  199.         IMPORT_CFM_FUNCTION CMGetCMVersion
  200.     ENDIF
  201.  
  202. ;
  203. ; pascal ConnHandle CMNew(short procID, CMRecFlags flags, CMBufferSizes desiredSizes, long refCon, long userData)
  204. ;
  205.     IF GENERATINGCFM THEN
  206.         IMPORT_CFM_FUNCTION CMNew
  207.     ENDIF
  208.  
  209. ;
  210. ; pascal void CMDispose(ConnHandle hConn)
  211. ;
  212.     IF GENERATINGCFM THEN
  213.         IMPORT_CFM_FUNCTION CMDispose
  214.     ENDIF
  215.  
  216. ;
  217. ; pascal CMErr CMListen(ConnHandle hConn, Boolean async, ConnectionCompletionUPP completor, long timeout)
  218. ;
  219.     IF GENERATINGCFM THEN
  220.         IMPORT_CFM_FUNCTION CMListen
  221.     ENDIF
  222.  
  223. ;
  224. ; pascal CMErr CMAccept(ConnHandle hConn, Boolean accept)
  225. ;
  226.     IF GENERATINGCFM THEN
  227.         IMPORT_CFM_FUNCTION CMAccept
  228.     ENDIF
  229.  
  230. ;
  231. ; pascal CMErr CMOpen(ConnHandle hConn, Boolean async, ConnectionCompletionUPP completor, long timeout)
  232. ;
  233.     IF GENERATINGCFM THEN
  234.         IMPORT_CFM_FUNCTION CMOpen
  235.     ENDIF
  236.  
  237. ;
  238. ; pascal CMErr CMClose(ConnHandle hConn, Boolean async, ConnectionCompletionUPP completor, long timeout, Boolean now)
  239. ;
  240.     IF GENERATINGCFM THEN
  241.         IMPORT_CFM_FUNCTION CMClose
  242.     ENDIF
  243.  
  244. ;
  245. ; pascal CMErr CMAbort(ConnHandle hConn)
  246. ;
  247.     IF GENERATINGCFM THEN
  248.         IMPORT_CFM_FUNCTION CMAbort
  249.     ENDIF
  250.  
  251. ;
  252. ; pascal CMErr CMStatus(ConnHandle hConn, CMBufferSizes sizes, CMStatFlags *flags)
  253. ;
  254.     IF GENERATINGCFM THEN
  255.         IMPORT_CFM_FUNCTION CMStatus
  256.     ENDIF
  257.  
  258. ;
  259. ; pascal void CMIdle(ConnHandle hConn)
  260. ;
  261.     IF GENERATINGCFM THEN
  262.         IMPORT_CFM_FUNCTION CMIdle
  263.     ENDIF
  264.  
  265. ;
  266. ; pascal void CMReset(ConnHandle hConn)
  267. ;
  268.     IF GENERATINGCFM THEN
  269.         IMPORT_CFM_FUNCTION CMReset
  270.     ENDIF
  271.  
  272. ;
  273. ; pascal void CMBreak(ConnHandle hConn, long duration, Boolean async, ConnectionCompletionUPP completor)
  274. ;
  275.     IF GENERATINGCFM THEN
  276.         IMPORT_CFM_FUNCTION CMBreak
  277.     ENDIF
  278.  
  279. ;
  280. ; pascal CMErr CMRead(ConnHandle hConn, void *theBuffer, long *toRead, CMChannel theChannel, Boolean async, ConnectionCompletionUPP completor, long timeout, CMFlags *flags)
  281. ;
  282.     IF GENERATINGCFM THEN
  283.         IMPORT_CFM_FUNCTION CMRead
  284.     ENDIF
  285.  
  286. ;
  287. ; pascal CMErr CMWrite(ConnHandle hConn, const void *theBuffer, long *toWrite, CMChannel theChannel, Boolean async, ConnectionCompletionUPP completor, long timeout, CMFlags flags)
  288. ;
  289.     IF GENERATINGCFM THEN
  290.         IMPORT_CFM_FUNCTION CMWrite
  291.     ENDIF
  292.  
  293. ;
  294. ; pascal CMErr CMIOKill(ConnHandle hConn, short which)
  295. ;
  296.     IF GENERATINGCFM THEN
  297.         IMPORT_CFM_FUNCTION CMIOKill
  298.     ENDIF
  299.  
  300. ;
  301. ; pascal void CMActivate(ConnHandle hConn, Boolean activate)
  302. ;
  303.     IF GENERATINGCFM THEN
  304.         IMPORT_CFM_FUNCTION CMActivate
  305.     ENDIF
  306.  
  307. ;
  308. ; pascal void CMResume(ConnHandle hConn, Boolean resume)
  309. ;
  310.     IF GENERATINGCFM THEN
  311.         IMPORT_CFM_FUNCTION CMResume
  312.     ENDIF
  313.  
  314. ;
  315. ; pascal Boolean CMMenu(ConnHandle hConn, short menuID, short item)
  316. ;
  317.     IF GENERATINGCFM THEN
  318.         IMPORT_CFM_FUNCTION CMMenu
  319.     ENDIF
  320.  
  321. ;
  322. ; pascal Boolean CMValidate(ConnHandle hConn)
  323. ;
  324.     IF GENERATINGCFM THEN
  325.         IMPORT_CFM_FUNCTION CMValidate
  326.     ENDIF
  327.  
  328. ;
  329. ; pascal void CMDefault(Ptr *theConfig, short procID, Boolean allocate)
  330. ;
  331.     IF GENERATINGCFM THEN
  332.         IMPORT_CFM_FUNCTION CMDefault
  333.     ENDIF
  334.  
  335. ;
  336. ; pascal Handle CMSetupPreflight(short procID, long *magicCookie)
  337. ;
  338.     IF GENERATINGCFM THEN
  339.         IMPORT_CFM_FUNCTION CMSetupPreflight
  340.     ENDIF
  341.  
  342. ;
  343. ; pascal Boolean CMSetupFilter(short procID, const void *theConfig, short count, DialogPtr theDialog, EventRecord *theEvent, short *theItem, long *magicCookie)
  344. ;
  345.     IF GENERATINGCFM THEN
  346.         IMPORT_CFM_FUNCTION CMSetupFilter
  347.     ENDIF
  348.  
  349. ;
  350. ; pascal void CMSetupSetup(short procID, const void *theConfig, short count, DialogPtr theDialog, long *magicCookie)
  351. ;
  352.     IF GENERATINGCFM THEN
  353.         IMPORT_CFM_FUNCTION CMSetupSetup
  354.     ENDIF
  355.  
  356. ;
  357. ; pascal void CMSetupItem(short procID, const void *theConfig, short count, DialogPtr theDialog, short *theItem, long *magicCookie)
  358. ;
  359.     IF GENERATINGCFM THEN
  360.         IMPORT_CFM_FUNCTION CMSetupItem
  361.     ENDIF
  362.  
  363. ;
  364. ; pascal void CMSetupXCleanup(short procID, const void *theConfig, short count, DialogPtr theDialog, Boolean OKed, long *magicCookie)
  365. ;
  366.     IF GENERATINGCFM THEN
  367.         IMPORT_CFM_FUNCTION CMSetupXCleanup
  368.     ENDIF
  369.  
  370. ;
  371. ; pascal void CMSetupPostflight(short procID)
  372. ;
  373.     IF GENERATINGCFM THEN
  374.         IMPORT_CFM_FUNCTION CMSetupPostflight
  375.     ENDIF
  376.  
  377. ;
  378. ; pascal Ptr CMGetConfig(ConnHandle hConn)
  379. ;
  380.     IF GENERATINGCFM THEN
  381.         IMPORT_CFM_FUNCTION CMGetConfig
  382.     ENDIF
  383.  
  384. ;
  385. ; pascal short CMSetConfig(ConnHandle hConn, const void *thePtr)
  386. ;
  387.     IF GENERATINGCFM THEN
  388.         IMPORT_CFM_FUNCTION CMSetConfig
  389.     ENDIF
  390.  
  391. ;
  392. ; pascal OSErr CMIntlToEnglish(ConnHandle hConn, const void *inputPtr, Ptr *outputPtr, short language)
  393. ;
  394.     IF GENERATINGCFM THEN
  395.         IMPORT_CFM_FUNCTION CMIntlToEnglish
  396.     ENDIF
  397.  
  398. ;
  399. ; pascal OSErr CMEnglishToIntl(ConnHandle hConn, const void *inputPtr, Ptr *outputPtr, short language)
  400. ;
  401.     IF GENERATINGCFM THEN
  402.         IMPORT_CFM_FUNCTION CMEnglishToIntl
  403.     ENDIF
  404.  
  405. ;
  406. ; pascal long CMAddSearch(ConnHandle hConn, ConstStr255Param theString, CMSearchFlags flags, ConnectionSearchCallBackUPP callBack)
  407. ;
  408.     IF GENERATINGCFM THEN
  409.         IMPORT_CFM_FUNCTION CMAddSearch
  410.     ENDIF
  411.  
  412. ;
  413. ; pascal void CMRemoveSearch(ConnHandle hConn, long refnum)
  414. ;
  415.     IF GENERATINGCFM THEN
  416.         IMPORT_CFM_FUNCTION CMRemoveSearch
  417.     ENDIF
  418.  
  419. ;
  420. ; pascal void CMClearSearch(ConnHandle hConn)
  421. ;
  422.     IF GENERATINGCFM THEN
  423.         IMPORT_CFM_FUNCTION CMClearSearch
  424.     ENDIF
  425.  
  426. ;
  427. ; pascal CMErr CMGetConnEnvirons(ConnHandle hConn, ConnEnvironRec *theEnvirons)
  428. ;
  429.     IF GENERATINGCFM THEN
  430.         IMPORT_CFM_FUNCTION CMGetConnEnvirons
  431.     ENDIF
  432.  
  433. ;
  434. ; pascal short CMChoose(ConnHandle *hConn, Point where, ConnectionChooseIdleUPP idle)
  435. ;
  436.     IF GENERATINGCFM THEN
  437.         IMPORT_CFM_FUNCTION CMChoose
  438.     ENDIF
  439.  
  440. ;
  441. ; pascal void CMEvent(ConnHandle hConn, const EventRecord *theEvent)
  442. ;
  443.     IF GENERATINGCFM THEN
  444.         IMPORT_CFM_FUNCTION CMEvent
  445.     ENDIF
  446.  
  447. ;
  448. ; pascal void CMGetToolName(short procID, Str255 name)
  449. ;
  450.     IF GENERATINGCFM THEN
  451.         IMPORT_CFM_FUNCTION CMGetToolName
  452.     ENDIF
  453.  
  454. ;
  455. ; pascal short CMGetProcID(ConstStr255Param name)
  456. ;
  457.     IF GENERATINGCFM THEN
  458.         IMPORT_CFM_FUNCTION CMGetProcID
  459.     ENDIF
  460.  
  461. ;
  462. ; pascal void CMSetRefCon(ConnHandle hConn, long refCon)
  463. ;
  464.     IF GENERATINGCFM THEN
  465.         IMPORT_CFM_FUNCTION CMSetRefCon
  466.     ENDIF
  467.  
  468. ;
  469. ; pascal long CMGetRefCon(ConnHandle hConn)
  470. ;
  471.     IF GENERATINGCFM THEN
  472.         IMPORT_CFM_FUNCTION CMGetRefCon
  473.     ENDIF
  474.  
  475. ;
  476. ; pascal long CMGetUserData(ConnHandle hConn)
  477. ;
  478.     IF GENERATINGCFM THEN
  479.         IMPORT_CFM_FUNCTION CMGetUserData
  480.     ENDIF
  481.  
  482. ;
  483. ; pascal void CMSetUserData(ConnHandle hConn, long userData)
  484. ;
  485.     IF GENERATINGCFM THEN
  486.         IMPORT_CFM_FUNCTION CMSetUserData
  487.     ENDIF
  488.  
  489. ;
  490. ; pascal void CMGetErrorString(ConnHandle hConn, short id, Str255 errMsg)
  491. ;
  492.     IF GENERATINGCFM THEN
  493.         IMPORT_CFM_FUNCTION CMGetErrorString
  494.     ENDIF
  495.  
  496. ;
  497. ; pascal CMErr CMNewIOPB(ConnHandle hConn, CMIOPBPtr *theIOPB)
  498. ;
  499.     IF GENERATINGCFM THEN
  500.         IMPORT_CFM_FUNCTION CMNewIOPB
  501.     ENDIF
  502.  
  503. ;
  504. ; pascal CMErr CMDisposeIOPB(ConnHandle hConn, CMIOPBPtr theIOPB)
  505. ;
  506.     IF GENERATINGCFM THEN
  507.         IMPORT_CFM_FUNCTION CMDisposeIOPB
  508.     ENDIF
  509.  
  510. ;
  511. ; pascal CMErr CMPBRead(ConnHandle hConn, CMIOPBPtr theIOPB, Boolean async)
  512. ;
  513.     IF GENERATINGCFM THEN
  514.         IMPORT_CFM_FUNCTION CMPBRead
  515.     ENDIF
  516.  
  517. ;
  518. ; pascal CMErr CMPBWrite(ConnHandle hConn, CMIOPBPtr theIOPB, Boolean async)
  519. ;
  520.     IF GENERATINGCFM THEN
  521.         IMPORT_CFM_FUNCTION CMPBWrite
  522.     ENDIF
  523.  
  524. ;
  525. ; pascal CMErr CMPBIOKill(ConnHandle hConn, CMIOPBPtr theIOPB)
  526. ;
  527.     IF GENERATINGCFM THEN
  528.         IMPORT_CFM_FUNCTION CMPBIOKill
  529.     ENDIF
  530.  
  531.     ENDIF
  532.     ENDIF ; __CONNECTIONS__ 
  533.  
  534.